/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package io.datavines.metric.api;

import io.datavines.spi.SPI;

import java.util.Map;

@SPI
public interface ExpectedValue {

    /**
     * get value name
     * @return String
     */
    String getName();

    String getZhName();

    default String getNameByLanguage(boolean isEn) {
        return isEn ? getName() : getZhName();
    }

    /**
     * get value type
     * @return String
     */
    String getKey(Map<String,String> inputParameter);

    /**
     * get value execute sql
     * @return String
     */
    String getExecuteSql(Map<String,String> inputParameter);

    /**
     * get output table name
     * @return String
     */
    String getOutputTable(Map<String,String> inputParameter);

    /**
     * need to read actual value from system database
     * @return
     */
    boolean isNeedDefaultDatasource();

    void prepare(Map<String,String> config);

}
